RAIS  3.2
RAIS::DataAccessLayer::UserManagement Class Reference

This class implements D.A.L. methods for user managements. More...

List of all members.

Static Public Member Functions

static UserData GetUserData (string userName)
 This method retrieves from DB a user data object for the specified user name .
static List< Facility > getFacilitiesByPractice (int practiceID)
static List< UserAssignment > GetUserAssignmentsForUser (UserData user, DateTime selectedDate)
static List< UserAssignment > GetUserAssignmentsForUser (UserData user)
static List< UserAssignment > GetUserAssignmentHistoryForUser (UserData user)
static bool UserExists (string userName)
 This method verifies whether the specified user exists in DB.
static bool LoginUser (UserData userData)
 This method fixes the fact of user's logon in DB.
static bool LogoutUser (UserData userData, bool isLoggOffClick)
 This method fixes the fact of user's logout in DB.
static bool AddAccountRequest (UserData userData, ref string returnMessage)
 This method adds a new account request into DB.
static bool ReleaseAccountRequest (UserData userData, ref string returnMessage)
 This method releases an account request into DB.
static bool RejectAccountRequest (UserData userData, ref string returnMessage)
 This method rejects an account request into DB.
static bool AddUser (UserData userData, ref string returnMessage)
 This method adds a new user into DB.
static bool ModifyUser (UserData userData, ref string returnMessage)
 This method saves modificaton of an existing user's details in DB.
static bool AddDataRole (string dataRoleName, ref string returnMessage)
 This method adds a new user into DB.
static bool SaveDataRole (DataRole dataRole, ref string returnMessage)
 This method saves a data role in DB.
static bool RemoveDataRole (DataRole dataRole, ref string returnMessage)
 This method removes a data role from DB.
static bool AddDataRoleAttribute (DataRole dataRole, DataRoleAttribute dataRoleAttribute, ref string returnMessage)
 This method adds a new data role attribute to DB.
static bool RemoveDataRoleAttribute (DataRole dataRole, DataRoleAttribute dataRoleAttribute, ref string returnMessage)
 This method removes a data role attribute through from the specified data role.
static bool AddFunctionRole (string functionRoleName, ref string returnMessage)
 This method adds a new function role to DB.
static bool AddFunctionRole (string functionRoleName, FunctionRole.ValidationType validationType, ref string returnMessage)
 This method adds a new function role to DB.
static bool SaveFunctionRole (FunctionRole functionRole, ref string returnMessage)
 This method saves a function role in DB.
static bool RemoveFunctionRole (FunctionRole functionRole, ref string returnMessage)
 This method removes a function role through DB.
static bool AddFunctionRoleAttribute (FunctionRole functionRole, FunctionRoleAttribute functionRoleAttribute, ref string returnMessage)
 This method adds a new function role attribute to DB.
static bool RemoveFunctionRoleAttribute (FunctionRole functionRole, FunctionRoleAttribute functionRoleAttribute, ref string returnMessage)
 This method removes a function role attribute through from the specified function role.
static bool AddUserType (FunctionRole functionRole, UserTypeData userType, ref string returnMessage)
 This method adds a new user type to the specified functional role in DB.
static bool RemoveUserType (FunctionRole functionRole, UserTypeData userType, ref string returnMessage)
 This method removes a user type through the specified functional role in DB.
static bool ValidateRemoveUserTypeFromFunctionRole (FunctionRole functionRole, UserTypeData userType, ref string returnMessage)
static Districts GetDistrictsByRegion (Region region)
 This method retrieves a list of all disrticts available for the specified region.
static Facilities GetFacilitiesByRegionAndDistrict (Region region, District district)
 This method retrieves from a list of facilities for the specified region and district.
static FunctionRoleCategories GetAllowCustomizationCategories ()
 This method retrieves from DB allow customization functional role categories.
static FunctionRoleSubcategories GetFunctionalRoleSubcategories (FunctionRole.Category category)
 This method retrieves from DB a list of all available functional role subcategories for the specified category.
static FunctionRoleSubcategories GetFunctionalRoleSubcategories (FunctionRole.Category category, bool withAll)
 This method retrieves from DB a list of all available functional role subcategories for the specified category without "All Subcategories" line.
static FunctionRoleSubcategories GetFunctionalRoleSubcategories (FunctionRole.Category category, bool withAll, bool showProtectors, bool showEvaluators)
 This method retrieves from DB a list of all available functional role subcategories for the specified category.
static Masks GetMasks (FunctionRole.Category category, FunctionRole.Subcategory subcategory)
 This method retrieves from DAL a list of all available masks for the specified category and subcategory.
static Masks GetMasksWithoutAll (FunctionRole.Category category, FunctionRole.Subcategory subcategory, bool withHidden)
 This method retrieves from DAL a list of all available masks for the specified category and subcategory without "All Masks" line.
static Masks GetMasksWithoutAll (FunctionRole.Category category, FunctionRole.Subcategory subcategory, DynamicMask.DynamicMaskTypeData dynamicMaskType)
 This method retrieves from DAL a list of all available masks for the specified category, subcategory and type without "All Masks" line.
static XmlDocument GetSiteMapByUser (UserData user, bool designMode)
 This method retrieves the site map from DB. The retrieved site map provided with user-specific access right indications for the specified user.
static void GetMaskByReference (string reference, out string CategoryID, out string SubcategoryID, out string MaskID)
static Facility GetFacilityByID (int facilityID)
 This method gets Facility object by facility ID.
static Department GetDepartmentByID (int departmentID)
 This method gets Department object by facility ID.
static FunctionRoles GetFunctionalRolesByUserType (UserTypeData userTypeData)
 This method retrieves from DB functional roles by user type ID.
static bool AddSubcategory (FunctionRole.Subcategory subcategory, ref string returnMessage)
 This method adds a new subcategory into DB.
static bool RemoveSubcategory (int subcategoryID, ref string returnMessage)
 This method removes a subcategory from DB.
static bool SaveSubcategory (FunctionRole.Subcategory subcategory, ref string returnMessage)
 This method adds a new subcategory into DB.
static bool SaveSubcategoryOrder (FunctionRole.Subcategory subcategory, ref string returnMessage)
 This method adds a new subcategory into DB.
static void UpdateContextVisibleName (string contextName, string contextVisibleName)
 This method retrieves from DB user statuses history.
static void DeleteContext (string contextName)
static Dictionary< string, string > GetUserStatusesHistoryByUser (UserData user)
static bool IsActiveUser (UserData user)
static FunctionRoleTypes GetFunctionRoleTypes ()
 This method retrieves from DB function role types.
static MessageBoxRestrictions getActiveMessageBoxRestrictionsForUser (UserData user)
static MessageBoxRestrictions getActiveMessageBoxRestrictionsForUser (UserData user, DateTime messageDate)
 This method retrieves all MessageBoxRestrictions for the given usre.
static MessageBoxRestrictions getAllActiveMessageBoxRestrictionsForUser (UserData user, DateTime messageDate)
 This method retrieves all MessageBoxRestrictions for the given usre.
static MessageBoxRestrictions getAllActiveMessageBoxRestrictionsForUser (UserData user)
static DataRole getMessageBoxDataRoleByUser (UserData user)
 This method retrieves the DataRole of MessageboxRestrictions of the given user.
static DataRoles getMessageBoxTakenOverDataRolesByUser (UserData user)
 This method retrieves the DataRoles of taken over MessageboxRestrictions of the given user.
static bool saveMessageboxRestriction (UserData user, MessageBoxRestriction newMbr, ref string returnMessage)
static bool editMessageboxRestriction (UserData user, MessageBoxRestriction mbr, ref string returnMessage)
static bool deleteMessageboxRestriction (UserData user, MessageBoxRestriction mbr, ref string returnMessage)
static DataRole getMessageBoxDataRoleByUserAndDate (UserData user, DateTime date)
 This method retrieves the DataRole of MessageboxRestrictions of the given user and date.
static List
< MessageBoxRestriction > 
MessageboxRestrictionHistoryForUser (UserData user, ref string returnMessage)
static List< UserData > GetUserFreeToTakeOver ()
static bool clearTakeOverForUser (UserData user)
static bool createUserAssignmentForUser (UserAssignment ua, UserData ud, ref string outputMessage)
static bool editUserAssignment (UserAssignment ua, ref string outputMessage)
static bool deleteUserAssignment (UserAssignment ua, ref string outputMessage)
static Users GetLevelThreeUsers ()
 This method retrieves from DB list of users.
static Region GetRegionForFacility (Facility facility)
 This method retrieves from DB regions for a given facility.

Properties

static UserTypes UserTypes [get]
 This method retrieves a list of all supported user types.
static Users Users [get]
 This method retrieves a list of all available users.
static Users Validators [get]
 This method retrieves a list of all available validators.
static FunctionRoles FunctionalRoles [get]
 This method retrieves a list of all available functional roles.
static FunctionRoles PredefinedFunctionalRoles [get]
 This method retrieves a list of predefined functional roles.
static FunctionRoleCategories FunctionalRoleCategories [get]
 This method retrieves from DB a list of all available functional role categories.
static DataRoles DataRoles [get]
 This method retrieves a list of all available data roles.
static Regions Regions [get]
 This method retrieves a list of all available regions.
static Facilities Facilities [get]
 This method retrieves a list of all available facilities.
static Practices Practices [get]
 This method retrieves a list of all available practices.

Detailed Description

This class implements D.A.L. methods for user managements.


Member Function Documentation

static bool RAIS::DataAccessLayer::UserManagement::AddAccountRequest ( UserData  userData,
ref string  returnMessage 
) [static]

This method adds a new account request into DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 434 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddDataRole ( string  dataRoleName,
ref string  returnMessage 
) [static]

This method adds a new user into DB.

Parameters:
dataRoleNameData role name.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 640 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddDataRoleAttribute ( DataRole  dataRole,
DataRoleAttribute  dataRoleAttribute,
ref string  returnMessage 
) [static]

This method adds a new data role attribute to DB.

Parameters:
dataRoleData role.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 735 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddFunctionRole ( string  functionRoleName,
ref string  returnMessage 
) [static]

This method adds a new function role to DB.

Parameters:
functionRoleFunctional role name.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 818 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddFunctionRole ( string  functionRoleName,
FunctionRole.ValidationType  validationType,
ref string  returnMessage 
) [static]

This method adds a new function role to DB.

Parameters:
functionRoleFunctional role name.
validationTypeFunctional role validation type.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 830 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddFunctionRoleAttribute ( FunctionRole  functionRole,
FunctionRoleAttribute  functionRoleAttribute,
ref string  returnMessage 
) [static]

This method adds a new function role attribute to DB.

Parameters:
functionRoleFunction role.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 926 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddSubcategory ( FunctionRole.Subcategory  subcategory,
ref string  returnMessage 
) [static]

This method adds a new subcategory into DB.

Parameters:
subcategory- Subcategory object to be added.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1532 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddUser ( UserData  userData,
ref string  returnMessage 
) [static]

This method adds a new user into DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 539 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::AddUserType ( FunctionRole  functionRole,
UserTypeData  userType,
ref string  returnMessage 
) [static]

This method adds a new user type to the specified functional role in DB.

Parameters:
functionRoleFunctional role.
userTypeobject of UserTypeData type to be added.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1002 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::clearTakeOverForUser ( UserData  user) [static]

Definition at line 2764 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::createUserAssignmentForUser ( UserAssignment  ua,
UserData  ud,
ref string  outputMessage 
) [static]

Definition at line 2788 of file UserManagement.cs.

static void RAIS::DataAccessLayer::UserManagement::DeleteContext ( string  contextName) [static]

Definition at line 1679 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::deleteMessageboxRestriction ( UserData  user,
MessageBoxRestriction  mbr,
ref string  returnMessage 
) [static]

Definition at line 2620 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::deleteUserAssignment ( UserAssignment  ua,
ref string  outputMessage 
) [static]

Definition at line 2845 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::editMessageboxRestriction ( UserData  user,
MessageBoxRestriction  mbr,
ref string  returnMessage 
) [static]

Definition at line 2560 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::editUserAssignment ( UserAssignment  ua,
ref string  outputMessage 
) [static]

Definition at line 2817 of file UserManagement.cs.

static MessageBoxRestrictions RAIS::DataAccessLayer::UserManagement::getActiveMessageBoxRestrictionsForUser ( UserData  user) [static]

Definition at line 2316 of file UserManagement.cs.

static MessageBoxRestrictions RAIS::DataAccessLayer::UserManagement::getActiveMessageBoxRestrictionsForUser ( UserData  user,
DateTime  messageDate 
) [static]

This method retrieves all MessageBoxRestrictions for the given usre.

Parameters:
userUserData.
Returns:
a list of MessageBoxRestrictions #-#

Definition at line 2347 of file UserManagement.cs.

static MessageBoxRestrictions RAIS::DataAccessLayer::UserManagement::getAllActiveMessageBoxRestrictionsForUser ( UserData  user,
DateTime  messageDate 
) [static]

This method retrieves all MessageBoxRestrictions for the given usre.

Parameters:
userUserData.
Returns:
a list of MessageBoxRestrictions #-#

Definition at line 2379 of file UserManagement.cs.

static MessageBoxRestrictions RAIS::DataAccessLayer::UserManagement::getAllActiveMessageBoxRestrictionsForUser ( UserData  user) [static]

Definition at line 2405 of file UserManagement.cs.

static FunctionRoleCategories RAIS::DataAccessLayer::UserManagement::GetAllowCustomizationCategories ( ) [static]

This method retrieves from DB allow customization functional role categories.

Returns:
dictionary with Category Name as key and FunctionalRole.Category object as value

Definition at line 1171 of file UserManagement.cs.

static Department RAIS::DataAccessLayer::UserManagement::GetDepartmentByID ( int  departmentID) [static]

This method gets Department object by facility ID.

Parameters:
departmentIDID of department in DB

Definition at line 1467 of file UserManagement.cs.

static Districts RAIS::DataAccessLayer::UserManagement::GetDistrictsByRegion ( Region  region) [static]

This method retrieves a list of all disrticts available for the specified region.

Parameters:
regionName of the region.
Returns:
Array of strings, containing available district names

Definition at line 1101 of file UserManagement.cs.

static List<Facility> RAIS::DataAccessLayer::UserManagement::getFacilitiesByPractice ( int  practiceID) [static]

Definition at line 256 of file UserManagement.cs.

static Facilities RAIS::DataAccessLayer::UserManagement::GetFacilitiesByRegionAndDistrict ( Region  region,
District  district 
) [static]

This method retrieves from a list of facilities for the specified region and district.

Parameters:
regionName of the region.
districtName of the district.
Returns:
Array of strings, containing available region names

Definition at line 1132 of file UserManagement.cs.

static Facility RAIS::DataAccessLayer::UserManagement::GetFacilityByID ( int  facilityID) [static]

This method gets Facility object by facility ID.

Parameters:
facilityIDID of facility in DB

Definition at line 1436 of file UserManagement.cs.

static FunctionRoles RAIS::DataAccessLayer::UserManagement::GetFunctionalRolesByUserType ( UserTypeData  userTypeData) [static]

This method retrieves from DB functional roles by user type ID.

Returns:
Dictionary of funcitnal role names vs functional role object

Definition at line 1499 of file UserManagement.cs.

static FunctionRoleSubcategories RAIS::DataAccessLayer::UserManagement::GetFunctionalRoleSubcategories ( FunctionRole.Category  category) [static]

This method retrieves from DB a list of all available functional role subcategories for the specified category.

/*!

Parameters:
categoryCategory
Returns:
Dictionary of funcitnal role subcategory names vs functional role subcategory objects

Definition at line 1202 of file UserManagement.cs.

static FunctionRoleSubcategories RAIS::DataAccessLayer::UserManagement::GetFunctionalRoleSubcategories ( FunctionRole.Category  category,
bool  withAll 
) [static]

This method retrieves from DB a list of all available functional role subcategories for the specified category without "All Subcategories" line.

Parameters:
categoryCategory
withAll- Gets "All Subcategories" row in result Dictionary if true
Returns:
Dictionary of funcitnal role subcategory names vs functional role subcategory objects

Definition at line 1212 of file UserManagement.cs.

static FunctionRoleSubcategories RAIS::DataAccessLayer::UserManagement::GetFunctionalRoleSubcategories ( FunctionRole.Category  category,
bool  withAll,
bool  showProtectors,
bool  showEvaluators 
) [static]

This method retrieves from DB a list of all available functional role subcategories for the specified category.

Parameters:
categoryCategory
withAll- Gets "All Subcategories" row in result Dictionary if true
hidden- Gets hidden subcategories in result Dictionary if true
Returns:
Dictionary of funcitnal role subcategory names vs functional role subcategory objects

Definition at line 1223 of file UserManagement.cs.

static FunctionRoleTypes RAIS::DataAccessLayer::UserManagement::GetFunctionRoleTypes ( ) [static]

This method retrieves from DB function role types.

Returns:
dictionary with Type Visible Name as key and FunctionRole.Type Class Object as value

Definition at line 2206 of file UserManagement.cs.

static Users RAIS::DataAccessLayer::UserManagement::GetLevelThreeUsers ( ) [static]

This method retrieves from DB list of users.

Returns:
array of strings of users names

Definition at line 2876 of file UserManagement.cs.

static void RAIS::DataAccessLayer::UserManagement::GetMaskByReference ( string  reference,
out string  CategoryID,
out string  SubcategoryID,
out string  MaskID 
) [static]

Definition at line 1404 of file UserManagement.cs.

static Masks RAIS::DataAccessLayer::UserManagement::GetMasks ( FunctionRole.Category  category,
FunctionRole.Subcategory  subcategory 
) [static]

This method retrieves from DAL a list of all available masks for the specified category and subcategory.

Parameters:
categoryCategory
subcategorySubcategory
Returns:
Dictionary of funcitnal role mask names vs mask objects

Definition at line 1265 of file UserManagement.cs.

static Masks RAIS::DataAccessLayer::UserManagement::GetMasksWithoutAll ( FunctionRole.Category  category,
FunctionRole.Subcategory  subcategory,
bool  withHidden 
) [static]

This method retrieves from DAL a list of all available masks for the specified category and subcategory without "All Masks" line.

Parameters:
categoryCategory
subcategorySubcategory
Returns:
Dictionary of funcitnal role mask names vs mask objects

Definition at line 1298 of file UserManagement.cs.

static Masks RAIS::DataAccessLayer::UserManagement::GetMasksWithoutAll ( FunctionRole.Category  category,
FunctionRole.Subcategory  subcategory,
DynamicMask.DynamicMaskTypeData  dynamicMaskType 
) [static]

This method retrieves from DAL a list of all available masks for the specified category, subcategory and type without "All Masks" line.

Parameters:
categoryCategory
subcategorySubcategory
dynamicMaskTypeDynamic mask type as DynamicMaskTypeData object
Returns:
Dictionary of funcitnal role mask names vs mask objects

Definition at line 1340 of file UserManagement.cs.

static DataRole RAIS::DataAccessLayer::UserManagement::getMessageBoxDataRoleByUser ( UserData  user) [static]

This method retrieves the DataRole of MessageboxRestrictions of the given user.

Parameters:
userUserData.
Returns:
DataRole #+#

Definition at line 2437 of file UserManagement.cs.

static DataRole RAIS::DataAccessLayer::UserManagement::getMessageBoxDataRoleByUserAndDate ( UserData  user,
DateTime  date 
) [static]

This method retrieves the DataRole of MessageboxRestrictions of the given user and date.

Parameters:
userUserData.
Returns:
DataRole

Definition at line 2661 of file UserManagement.cs.

static DataRoles RAIS::DataAccessLayer::UserManagement::getMessageBoxTakenOverDataRolesByUser ( UserData  user) [static]

This method retrieves the DataRoles of taken over MessageboxRestrictions of the given user.

Parameters:
userUserData.
Returns:
DataRole

Definition at line 2472 of file UserManagement.cs.

static Region RAIS::DataAccessLayer::UserManagement::GetRegionForFacility ( Facility  facility) [static]

This method retrieves from DB regions for a given facility.

Returns:
array of strings of regions names

Definition at line 2924 of file UserManagement.cs.

static XmlDocument RAIS::DataAccessLayer::UserManagement::GetSiteMapByUser ( UserData  user,
bool  designMode 
) [static]

This method retrieves the site map from DB. The retrieved site map provided with user-specific access right indications for the specified user.

Parameters:
userUser data
Returns:
site map xml document.

Definition at line 1375 of file UserManagement.cs.

static List<UserAssignment> RAIS::DataAccessLayer::UserManagement::GetUserAssignmentHistoryForUser ( UserData  user) [static]

Definition at line 334 of file UserManagement.cs.

static List<UserAssignment> RAIS::DataAccessLayer::UserManagement::GetUserAssignmentsForUser ( UserData  user,
DateTime  selectedDate 
) [static]

Definition at line 282 of file UserManagement.cs.

static List<UserAssignment> RAIS::DataAccessLayer::UserManagement::GetUserAssignmentsForUser ( UserData  user) [static]

Definition at line 307 of file UserManagement.cs.

static UserData RAIS::DataAccessLayer::UserManagement::GetUserData ( string  userName) [static]

This method retrieves from DB a user data object for the specified user name .

Parameters:
userNameUser's login name.
Returns:
UserData object with properties of the specified user
Note:
If the specified user is not found, the methods throws an exception.

Definition at line 245 of file UserManagement.cs.

static List<UserData> RAIS::DataAccessLayer::UserManagement::GetUserFreeToTakeOver ( ) [static]

Definition at line 2728 of file UserManagement.cs.

static Dictionary<string, string> RAIS::DataAccessLayer::UserManagement::GetUserStatusesHistoryByUser ( UserData  user) [static]

Definition at line 1694 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::IsActiveUser ( UserData  user) [static]

Definition at line 1759 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::LoginUser ( UserData  userData) [static]

This method fixes the fact of user's logon in DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 376 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::LogoutUser ( UserData  userData,
bool  isLoggOffClick 
) [static]

This method fixes the fact of user's logout in DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 404 of file UserManagement.cs.

static List<MessageBoxRestriction> RAIS::DataAccessLayer::UserManagement::MessageboxRestrictionHistoryForUser ( UserData  user,
ref string  returnMessage 
) [static]

Definition at line 2693 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::ModifyUser ( UserData  userData,
ref string  returnMessage 
) [static]

This method saves modificaton of an existing user's details in DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 588 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RejectAccountRequest ( UserData  userData,
ref string  returnMessage 
) [static]

This method rejects an account request into DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 509 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::ReleaseAccountRequest ( UserData  userData,
ref string  returnMessage 
) [static]

This method releases an account request into DB.

Parameters:
userDataUser data.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 479 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RemoveDataRole ( DataRole  dataRole,
ref string  returnMessage 
) [static]

This method removes a data role from DB.

Parameters:
dataRoleData role.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 703 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RemoveDataRoleAttribute ( DataRole  dataRole,
DataRoleAttribute  dataRoleAttribute,
ref string  returnMessage 
) [static]

This method removes a data role attribute through from the specified data role.

Parameters:
dataRoleData role.
dataRoleAttributeData role attribute to be removed.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 777 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RemoveFunctionRole ( FunctionRole  functionRole,
ref string  returnMessage 
) [static]

This method removes a function role through DB.

Parameters:
functionRoleFunctional role object.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 896 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RemoveFunctionRoleAttribute ( FunctionRole  functionRole,
FunctionRoleAttribute  functionRoleAttribute,
ref string  returnMessage 
) [static]

This method removes a function role attribute through from the specified function role.

Parameters:
functionRoleFunction role.
functionRoleAttributeFunction role attribute to be removed.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 966 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RemoveSubcategory ( int  subcategoryID,
ref string  returnMessage 
) [static]

This method removes a subcategory from DB.

Parameters:
subcategoryID- Subcategory ID.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1568 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::RemoveUserType ( FunctionRole  functionRole,
UserTypeData  userType,
ref string  returnMessage 
) [static]

This method removes a user type through the specified functional role in DB.

Parameters:
functionRoleFunctional role.
userTypeobject of UserTypeData type to be removed.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1035 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::SaveDataRole ( DataRole  dataRole,
ref string  returnMessage 
) [static]

This method saves a data role in DB.

Parameters:
dataRoleData role.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 671 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::SaveFunctionRole ( FunctionRole  functionRole,
ref string  returnMessage 
) [static]

This method saves a function role in DB.

Parameters:
functionRolefFunction role object.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 863 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::saveMessageboxRestriction ( UserData  user,
MessageBoxRestriction  newMbr,
ref string  returnMessage 
) [static]

Definition at line 2501 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::SaveSubcategory ( FunctionRole.Subcategory  subcategory,
ref string  returnMessage 
) [static]

This method adds a new subcategory into DB.

Parameters:
subcategory- Subcategory object to be saved.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1598 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::SaveSubcategoryOrder ( FunctionRole.Subcategory  subcategory,
ref string  returnMessage 
) [static]

This method adds a new subcategory into DB.

Parameters:
subcategory- Subcategory object which to be saved.
returnMessageMessage string about the action result.
Returns:
true on success, otherwise false;

Definition at line 1630 of file UserManagement.cs.

static void RAIS::DataAccessLayer::UserManagement::UpdateContextVisibleName ( string  contextName,
string  contextVisibleName 
) [static]

This method retrieves from DB user statuses history.

Returns:
dictionary with status date as key and user status visible name as value

This method updates [Context Visible Name] field in Context table.

Definition at line 1663 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::UserExists ( string  userName) [static]

This method verifies whether the specified user exists in DB.

Parameters:
userNameUser's login name.
Returns:
true if the user exists, otherwise false

Definition at line 366 of file UserManagement.cs.

static bool RAIS::DataAccessLayer::UserManagement::ValidateRemoveUserTypeFromFunctionRole ( FunctionRole  functionRole,
UserTypeData  userType,
ref string  returnMessage 
) [static]

Definition at line 1061 of file UserManagement.cs.


Property Documentation

DataRoles RAIS::DataAccessLayer::UserManagement::DataRoles [static, get]

This method retrieves a list of all available data roles.

Returns:
Array of strings, containing available data roles
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 179 of file UserManagement.cs.

Facilities RAIS::DataAccessLayer::UserManagement::Facilities [static, get]

This method retrieves a list of all available facilities.

Returns:
Array of strings, containing available facilities
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 209 of file UserManagement.cs.

FunctionRoleCategories RAIS::DataAccessLayer::UserManagement::FunctionalRoleCategories [static, get]

This method retrieves from DB a list of all available functional role categories.

Returns:
Dictionary of funcitnal role category names vs functional role category objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 165 of file UserManagement.cs.

FunctionRoles RAIS::DataAccessLayer::UserManagement::FunctionalRoles [static, get]

This method retrieves a list of all available functional roles.

Returns:
Dictionary of funcitnal role names vs functional role objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 137 of file UserManagement.cs.

Practices RAIS::DataAccessLayer::UserManagement::Practices [static, get]

This method retrieves a list of all available practices.

Returns:
Array of strings, containing available practices
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively. #-#

Definition at line 225 of file UserManagement.cs.

FunctionRoles RAIS::DataAccessLayer::UserManagement::PredefinedFunctionalRoles [static, get]

This method retrieves a list of predefined functional roles.

Returns:
Dictionary of funcitnal role names vs functional role objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 151 of file UserManagement.cs.

Regions RAIS::DataAccessLayer::UserManagement::Regions [static, get]

This method retrieves a list of all available regions.

Returns:
Dictionary of region names vs region objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 194 of file UserManagement.cs.

Users RAIS::DataAccessLayer::UserManagement::Users [static, get]

This method retrieves a list of all available users.

Returns:
Dictionary of user names vs user objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 107 of file UserManagement.cs.

UserTypes RAIS::DataAccessLayer::UserManagement::UserTypes [static, get]

This method retrieves a list of all supported user types.

Returns:
Array of strings, containing supported languages
Note:
The list is retrieved from a static member of this class. The latter is initialized in the static constructor from the enumerator RAIS.Common.UserManagement.UserData.UserTypes.

Definition at line 93 of file UserManagement.cs.

Users RAIS::DataAccessLayer::UserManagement::Validators [static, get]

This method retrieves a list of all available validators.

Returns:
Dictionary of user names vs user objects
Warning:
Addressing this property casues an MS SQL query. Use is for initialising a local variable instead of addressing it iteratively.

Definition at line 122 of file UserManagement.cs.


The documentation for this class was generated from the following file: